FHIR Server FHIR Server Version n/a

Resource StructureDefinition/FHIR Server from package hl7.v2plus#current (47 ms)

Package

hl7.v2plus

Type

StructureDefinition

FHIR Version

Source

http://somewhere.org/fhir/uv/v2plus/https://build.fhir.org/ig/HL7/v2ig/StructureDefinition-HD.html

Url

http://hl7.org/v2/StructureDefinition/HD

Version

0.0.0

Status

active

Date

2024-11-08T13:58:48+00:00

Name

Title

HL7 v2 HD Data Type

Experimental

False

Authority

hl7

Description

The HD is designed to be a more powerful and more general replacement for the application identifier of HL7 versions 2.1 and 2.2. It adds two additional components, the and the to the former application ID (which is renamed more generically to be the namespace ID). In the case where an HD identifies an entity that assigns/creates instance identifiers such as a particular patient registration system, it defines an "assigning authority". In the case where an HD identifies a location where instance identifiers are given out (although they may be created by another entity at another location) such as a particular "department of motor vehicles office location," it defines an "assigning facility". These two different uses of the HD appear in many of the extended data types. The "assigning authority" defined by the HD is similar in its role to the coding system (and version) part of the coded element data types: both identify a set of more discrete instance identifiers. The difference is that the set of HD-defined discrete instances contain identifiers of "real-world" things such as patient or clinical orders, while the coded element-defined set of discrete instances contains concept identifiers (codes). The HD is designed to be used either as a local identifier (with only the valued) or a publicly-assigned identifier, a UID ( and both valued). Syntactically, the HD is a group of two identifiers: a local identifier defined by the first component and a universal identifier defined by the second and third components. HDs that have defined third components (defined UID types) must have a second component that is unique within the series of IDs defined by that component. *Note:* The HD is used in fields that in earlier versions of HL7 used the IS data type. Thus, a single component HD (only the first component valued) will look like a simple IS data type for older systems expecting a single component in the place of the HD data type. If the first component for the HD data type is present, the second and third components are optional. If the third component is present, then the second must also be present (although in this case the first is optional). The second and third components must either both be valued (both non-null), or both be not valued (both null). This means that if all three components of the HD are valued, the entity identified by the first component is the same as the entity identified by components two and three taken together. However, implementers may choose, by site agreement, to specify that if all three components of the HD are valued, the first component defines a member in the set defined by the second and third components. Examples: Example 1: ISO example with only the 2^nd^ and 3^rd^ components valued: |^2.16.840.1.113883.19^ISO| The syntax of the second component is defined by the ISO standard for object identifiers, not by HL7 (for which the second component is of the ST data type). Thus the periods (".") in the second component are part of the ISO syntax, and are legal by the definition of the HL7 ST data type. Example 2: A UUID example |^478A0114-EBF0-7701-A023-6841FF05731A^UUID| Example 3: A DNS example |^falcon.iupui.edu^DNS| *Local examples:* Example 4: Local use only: a HD that looks like an IS data type |LAB1| |RX.PIMS.SystemB.KP.CA.SCA| Note that the syntax of the first component is not defined by HL7 but by the site according to its own needs: the only requirement is that the first component’s structure is allowed by the HL7 string (ST) data type, which is used for values by the IS data type. Example 5: Local identifier using components 2 and 3 only _[.underline]#(Deprecated as of v2.8 and will be withdrawn in V2.10)#_ |^RX.PIMS.SystemB.CA.SCA^M| An alternate way to encode the previous example, illustrating the use of the third component value of "M" (see file:///E:\V2\v2.9%20final%20Nov%20from%20Frank\V29_CH02C_Tables.docx#HL70301[_HL7 Table 0301 - Universal ID type_] below) to identify a locally-defined identifier set. The second component has the same value as the previous example but is now defined to be a member of a set of allowable values defined by a site for the identifier set “M”. _[.underline]#The use of local coding schemes as Universal ID Types is deprecated as of v 2.8; assigning authorities should be identified with true Universal IDs.#_ Example 6: local identifier and universal ID types: |LAB1^2.16.840.1.113883.19.1.2.3.3.4.6.7^ISO| A HD with an ISO "object Identifier" as a UID and a locally defined system name. Both the first component and the second and third (taken together) refer to the same entity. This example shows that the local value and the universal ID value may be transmitted with a single HD field.

Type

http://hl7.org/v2/StructureDefinition/HD

Kind

logical

Resources that use this resource

StructureDefinition

http://hl7.org/v2/StructureDefinition/CX

HL7 v2 CX Data Type

http://hl7.org/v2/StructureDefinition/ED

HL7 v2 ED Data Type

http://hl7.org/v2/StructureDefinition/NDL

HL7 v2 NDL Data Type

http://hl7.org/v2/StructureDefinition/PL

HL7 v2 PL Data Type

http://hl7.org/v2/StructureDefinition/PPN

HL7 v2 PPN Data Type

http://hl7.org/v2/StructureDefinition/RP

HL7 v2 RP Data Type

http://hl7.org/v2/StructureDefinition/XCN

HL7 v2 XCN Data Type

http://hl7.org/v2/StructureDefinition/XON

HL7 v2 XON Data Type

Resources that this resource uses

StructureDefinition

http://hl7.org/v2/StructureDefinition/ID

HL7 v2 ID Data Type

http://hl7.org/v2/StructureDefinition/IS

HL7 v2 IS Data Type

http://hl7.org/v2/StructureDefinition/ST

HL7 v2 String Primitive Type

http://hl7.org/v2/StructureDefinition/v2-complex-data-type

HL7 v2 Complex Data Type

http://terminology.hl7.org/ValueSet/v2-0301

hl7VS-universalIdType

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition HD

Name	Card.	Type	Description & Constraints
HD	0..*	V2ComplexDataType	hierarchic designator Instances of this logical model are not marked to be the target of a Reference
1	0..1	code	Namespace ID Binding: http://terminology.hl7.org/ValueSet/v2-0300 (required)
2	0..1	string	Universal ID
3	0..1	code	Universal ID Type Binding: hl7VS-universalIdType (required)
Documentation for this format

Source

{
  "resourceType" : "StructureDefinition",
  "id" : "HD",
  "meta" : {
    "profile" : [
      "http://hl7.org/v2/StructureDefinition/ComplexDataType-Profile"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition HD</b></p><a name=\"HD\"> </a><a name=\"hcHD\"> </a><a name=\"HD-en-US\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HD-definitions.html#HD\" title=\"Definition: The basic definition of the HD is that it identifies an (administrative or system or application or other) entity that has responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers, provider identifiers, etc.). This entity could be a particular health care application such as a registration system that assigns patient identifiers, a governmental entity such as a licensing authority that assigns professional identifiers or driversâ€™ license numbers, or a facility where such identifiers are assigned.\">HD</a><a name=\"HD\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-v2-complex-data-type.html\">V2ComplexDataType</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">hierarchic designator<br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span><br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HD-definitions.html#HD.1\">1</a><a name=\"HD.1\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-IS.html\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Namespace ID<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"http://terminology.hl7.org/ValueSet/v2-0300\">http://terminology.hl7.org/ValueSet/v2-0300</a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HD-definitions.html#HD.2\">2</a><a name=\"HD.2\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ST.html\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Universal ID</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HD-definitions.html#HD.3\">3</a><a name=\"HD.3\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ID.html\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Universal ID Type<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"http://terminology.hl7.org/6.0.2/ValueSet-v2-0301.html\" title=\"http://terminology.hl7.org/ValueSet/v2-0301\">hl7VS-universalIdType</a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "informative",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://somewhere.org/fhir/uv/v2plus/ImplementationGuide/hl7.other.uv.v2plus"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/v2/StructureDefinition/HD",
  "version" : "0.0.0",
  "name" : "HD",
  "title" : "HL7 v2 HD Data Type",
  "status" : "active",
  "date" : "2024-11-08T13:58:48+00:00",
  "publisher" : "HL7 International",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/Special/committees/v2mgmt"
        }
      ]
    }
  ],
  "description" : "The HD is designed to be a more powerful and more general replacement for the application identifier of HL7 versions 2.1 and 2.2. It adds two additional components, the <universal ID> and the <universal ID type> to the former application ID (which is renamed more generically to be the namespace ID).\n\nIn the case where an HD identifies an entity that assigns/creates instance identifiers such as a particular patient registration system, it defines an \"assigning authority\". In the case where an HD identifies a location where instance identifiers are given out (although they may be created by another entity at another location) such as a particular \"department of motor vehicles office location,\" it defines an \"assigning facility\". These two different uses of the HD appear in many of the extended data types.\n\nThe \"assigning authority\" defined by the HD is similar in its role to the coding system (and version) part of the coded element data types: both identify a set of more discrete instance identifiers. The difference is that the set of HD-defined discrete instances contain identifiers of \"real-world\" things such as patient or clinical orders, while the coded element-defined set of discrete instances contains concept identifiers (codes).\n\nThe HD is designed to be used either as a local identifier (with only the <namespace ID> valued) or a publicly-assigned identifier, a UID (<universal ID> and <universal ID type> both valued). Syntactically, the HD is a group of two identifiers: a local identifier defined by the first component and a universal identifier defined by the second and third components. HDs that have defined third components (defined UID types) must have a second component that is unique within the series of IDs defined by that component.\n\n*Note:* The HD is used in fields that in earlier versions of HL7 used the IS data type. Thus, a single component HD (only the first component valued) will look like a simple IS data type for older systems expecting a single component in the place of the HD data type.\n\nIf the first component for the HD data type is present, the second and third components are optional. If the third component is present, then the second must also be present (although in this case the first is optional). The second and third components must either both be valued (both non-null), or both be not valued (both null).\n\nThis means that if all three components of the HD are valued, the entity identified by the first component is the same as the entity identified by components two and three taken together. However, implementers may choose, by site agreement, to specify that if all three components of the HD are valued, the first component defines a member in the set defined by the second and third components.\n\nExamples:\n\nExample 1: ISO example with only the 2^nd^ and 3^rd^ components valued:\n\n|^2.16.840.1.113883.19^ISO|\n\nThe syntax of the second component is defined by the ISO standard for object identifiers, not by HL7 (for which the second component is of the ST data type). Thus the periods (\".\") in the second component are part of the ISO syntax, and are legal by the definition of the HL7 ST data type.\n\nExample 2: A UUID example\n\n|^478A0114-EBF0-7701-A023-6841FF05731A^UUID|\n\nExample 3: A DNS example\n\n|^falcon.iupui.edu^DNS|\n\n*Local examples:*\n\nExample 4: Local use only: a HD that looks like an IS data type\n\n|LAB1|\n\n|RX.PIMS.SystemB.KP.CA.SCA|\n\nNote that the syntax of the first component is not defined by HL7 but by the site according to its own needs: the only requirement is that the first componentâ€™s structure is allowed by the HL7 string (ST) data type, which is used for values by the IS data type.\n\nExample 5: Local identifier using components 2 and 3 only _[.underline]#(Deprecated as of v2.8 and will be withdrawn in V2.10)#_\n\n|^RX.PIMS.SystemB.CA.SCA^M|\n\nAn alternate way to encode the previous example, illustrating the use of the third component value of \"M\" (see file:///E:\\V2\\v2.9%20final%20Nov%20from%20Frank\\V29_CH02C_Tables.docx#HL70301[_HL7 Table 0301 - Universal ID type_] below) to identify a locally-defined identifier set. The second component has the same value as the previous example but is now defined to be a member of a set of allowable values defined by a site for the identifier set â€œMâ€. _[.underline]#The use of local coding schemes as Universal ID Types is deprecated as of v 2.8; assigning authorities should be identified with true Universal IDs.#_\n\nExample 6: local identifier and universal ID types:\n\n|LAB1^2.16.840.1.113883.19.1.2.3.3.4.6.7^ISO|\n\nA HD with an ISO \"object Identifier\" as a UID and a locally defined system name. Both the first component and the second and third (taken together) refer to the same entity. This example shows that the local value and the universal ID value may be transmitted with a single HD field.",
  "fhirVersion" : "5.0.0",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "http://hl7.org/v2/StructureDefinition/HD",
  "baseDefinition" : "http://hl7.org/v2/StructureDefinition/v2-complex-data-type",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "HD",
        "path" : "HD",
        "short" : "hierarchic designator",
        "definition" : "Definition: The basic definition of the HD is that it identifies an (administrative or system or application or other) entity that has responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers, provider identifiers, etc.). This entity could be a particular health care application such as a registration system that assigns patient identifiers, a governmental entity such as a licensing authority that assigns professional identifiers or driversâ€™ license numbers, or a facility where such identifiers are assigned.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "HD.1",
        "extension" : [
          {
            "url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
            "valueCode" : "O"
          },
          {
            "extension" : [
              {
                "url" : "length",
                "valueInteger" : 20
              },
              {
                "url" : "noTruncate",
                "valueBoolean" : true
              }
            ],
            "url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
          }
        ],
        "path" : "HD.1",
        "short" : "Namespace ID",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "HD.1",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/v2/StructureDefinition/IS"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v2-0300"
        }
      },
      {
        "id" : "HD.2",
        "extension" : [
          {
            "url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
            "valueCode" : "C"
          },
          {
            "extension" : [
              {
                "url" : "length",
                "valueInteger" : 199
              },
              {
                "url" : "noTruncate",
                "valueBoolean" : true
              }
            ],
            "url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
          }
        ],
        "path" : "HD.2",
        "short" : "Universal ID",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "HD.2",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      },
      {
        "id" : "HD.3",
        "extension" : [
          {
            "url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
            "valueCode" : "C"
          },
          {
            "extension" : [
              {
                "url" : "min",
                "valueInteger" : 1
              },
              {
                "url" : "max",
                "valueInteger" : 6
              }
            ],
            "url" : "http://hl7.org/v2/StructureDefinition/v2-length"
          }
        ],
        "path" : "HD.3",
        "short" : "Universal ID Type",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "HD.3",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/v2/StructureDefinition/ID"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v2-0301"
        }
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "HD",
        "path" : "HD",
        "short" : "hierarchic designator",
        "definition" : "Definition: The basic definition of the HD is that it identifies an (administrative or system or application or other) entity that has responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers, provider identifiers, etc.). This entity could be a particular health care application such as a registration system that assigns patient identifiers, a governmental entity such as a licensing authority that assigns professional identifiers or driversâ€™ license numbers, or a facility where such identifiers are assigned.",
        "min" : 0,
        "max" : "*"
      },
      {
        "id" : "HD.1",
        "extension" : [
          {
            "url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
            "valueCode" : "O"
          },
          {
            "extension" : [
              {
                "url" : "length",
                "valueInteger" : 20
              },
              {
                "url" : "noTruncate",
                "valueBoolean" : true
              }
            ],
            "url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
          }
        ],
        "path" : "HD.1",
        "short" : "Namespace ID",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/v2/StructureDefinition/IS"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v2-0300"
        }
      },
      {
        "id" : "HD.2",
        "extension" : [
          {
            "url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
            "valueCode" : "C"
          },
          {
            "extension" : [
              {
                "url" : "length",
                "valueInteger" : 199
              },
              {
                "url" : "noTruncate",
                "valueBoolean" : true
              }
            ],
            "url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
          }
        ],
        "path" : "HD.2",
        "short" : "Universal ID",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      },
      {
        "id" : "HD.3",
        "extension" : [
          {
            "url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
            "valueCode" : "C"
          },
          {
            "extension" : [
              {
                "url" : "min",
                "valueInteger" : 1
              },
              {
                "url" : "max",
                "valueInteger" : 6
              }
            ],
            "url" : "http://hl7.org/v2/StructureDefinition/v2-length"
          }
        ],
        "path" : "HD.3",
        "short" : "Universal ID Type",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/v2/StructureDefinition/ID"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v2-0301"
        }
      }
    ]
  }
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.